<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: src/Algorithm/IpUserScaling.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.12</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('IpUserScaling_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">IpUserScaling.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<a href="IpUserScaling_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">// Copyright (C) 2005, 2007 International Business Machines and others.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// All Rights Reserved.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// This code is published under the Eclipse Public License.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// Authors:  Carl Laird, Andreas Waechter     IBM    2005-06-25</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#ifndef __IPUSERSCALING_HPP__</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#define __IPUSERSCALING_HPP__</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="IpNLPScaling_8hpp.html">IpNLPScaling.hpp</a>&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="IpNLP_8hpp.html">IpNLP.hpp</a>&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceIpopt.html">Ipopt</a></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;{</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classIpopt_1_1UserScaling.html">   18</a></span>&#160;<span class="keyword">class </span><a class="code" href="classIpopt_1_1UserScaling.html">UserScaling</a>: <span class="keyword">public</span> <a class="code" href="classIpopt_1_1StandardScalingBase.html">StandardScalingBase</a></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;{</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;   <a class="code" href="classIpopt_1_1UserScaling.html#acd3ac1550bfb0bc0885ebb28dfadae10">UserScaling</a>(</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;const NLP&gt;</a>&amp; nlp)</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;      : <a class="code" href="classIpopt_1_1StandardScalingBase.html#a9735330546368626cfdd8f9855ff2b40">StandardScalingBase</a>(),</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;        <a class="code" href="classIpopt_1_1UserScaling.html#a560694066aa89b8367c221e9d40cff72">nlp_</a>(nlp)</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;   { }</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classIpopt_1_1UserScaling.html#ac109793d9baf2fe593019fe4796ee9d7">   30</a></span>&#160;   <span class="keyword">virtual</span> <a class="code" href="classIpopt_1_1UserScaling.html#ac109793d9baf2fe593019fe4796ee9d7">~UserScaling</a>()</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;   { }</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classIpopt_1_1UserScaling.html#a03a732dd0b8358de8a8a146e2ae5a0d8">   35</a></span>&#160;   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classIpopt_1_1UserScaling.html#a03a732dd0b8358de8a8a146e2ae5a0d8">DetermineScalingParametersImpl</a>(</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;const VectorSpace&gt;</a>    x_space,</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;const VectorSpace&gt;</a>    c_space,</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;const VectorSpace&gt;</a>    d_space,</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;const MatrixSpace&gt;</a>    jac_c_space,</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;const MatrixSpace&gt;</a>    jac_d_space,</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;const SymMatrixSpace&gt;</a> h_space,</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1Matrix.html">Matrix</a>&amp;                        Px_L,</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1Vector.html">Vector</a>&amp;                        x_L,</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1Matrix.html">Matrix</a>&amp;                        Px_U,</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1Vector.html">Vector</a>&amp;                        x_U,</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;      <a class="code" href="namespaceIpopt.html#ab75ce5f2ad60aa86e4dff723998e653f">Number</a>&amp;                              df,</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;      <a class="code" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;Vector&gt;</a>&amp;                    dx,</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;      <a class="code" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;Vector&gt;</a>&amp;                    dc,</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;      <a class="code" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;Vector&gt;</a>&amp;                    dd</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;   );</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classIpopt_1_1UserScaling.html#ae5e755c567dde8242cfed24e3adcec75">   65</a></span>&#160;   <a class="code" href="classIpopt_1_1UserScaling.html#ae5e755c567dde8242cfed24e3adcec75">UserScaling</a>(</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1UserScaling.html">UserScaling</a>&amp;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;   );</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classIpopt_1_1UserScaling.html#af20048b9fc20d9ba4342acf68ee704b0">   70</a></span>&#160;   <span class="keywordtype">void</span> <a class="code" href="classIpopt_1_1UserScaling.html#af20048b9fc20d9ba4342acf68ee704b0">operator=</a>(</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;      <span class="keyword">const</span> <a class="code" href="classIpopt_1_1UserScaling.html">UserScaling</a>&amp;</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;   );</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classIpopt_1_1UserScaling.html#a560694066aa89b8367c221e9d40cff72">   76</a></span>&#160;   <a class="code" href="classIpopt_1_1SmartPtr.html">SmartPtr&lt;const NLP&gt;</a> <a class="code" href="classIpopt_1_1UserScaling.html#a560694066aa89b8367c221e9d40cff72">nlp_</a>;</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;};</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;} <span class="comment">// namespace Ipopt</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassIpopt_1_1UserScaling_html_a03a732dd0b8358de8a8a146e2ae5a0d8"><div class="ttname"><a href="classIpopt_1_1UserScaling.html#a03a732dd0b8358de8a8a146e2ae5a0d8">Ipopt::UserScaling::DetermineScalingParametersImpl</a></div><div class="ttdeci">virtual void DetermineScalingParametersImpl(const SmartPtr&lt; const VectorSpace &gt; x_space, const SmartPtr&lt; const VectorSpace &gt; c_space, const SmartPtr&lt; const VectorSpace &gt; d_space, const SmartPtr&lt; const MatrixSpace &gt; jac_c_space, const SmartPtr&lt; const MatrixSpace &gt; jac_d_space, const SmartPtr&lt; const SymMatrixSpace &gt; h_space, const Matrix &amp;Px_L, const Vector &amp;x_L, const Matrix &amp;Px_U, const Vector &amp;x_U, Number &amp;df, SmartPtr&lt; Vector &gt; &amp;dx, SmartPtr&lt; Vector &gt; &amp;dc, SmartPtr&lt; Vector &gt; &amp;dd)</div><div class="ttdoc">This is the method that has to be overloaded by a particular scaling method that somehow computes the...</div></div>
<div class="ttc" id="aclassIpopt_1_1StandardScalingBase_html"><div class="ttname"><a href="classIpopt_1_1StandardScalingBase.html">Ipopt::StandardScalingBase</a></div><div class="ttdoc">This is a base class for many standard scaling techniques.</div><div class="ttdef"><b>Definition:</b> <a href="IpNLPScaling_8hpp_source.html#l00315">IpNLPScaling.hpp:316</a></div></div>
<div class="ttc" id="aclassIpopt_1_1UserScaling_html"><div class="ttname"><a href="classIpopt_1_1UserScaling.html">Ipopt::UserScaling</a></div><div class="ttdoc">This class does problem scaling by getting scaling parameters from the user (through the NLP interfac...</div><div class="ttdef"><b>Definition:</b> <a href="IpUserScaling_8hpp_source.html#l00018">IpUserScaling.hpp:19</a></div></div>
<div class="ttc" id="aIpNLPScaling_8hpp_html"><div class="ttname"><a href="IpNLPScaling_8hpp.html">IpNLPScaling.hpp</a></div></div>
<div class="ttc" id="aclassIpopt_1_1UserScaling_html_af20048b9fc20d9ba4342acf68ee704b0"><div class="ttname"><a href="classIpopt_1_1UserScaling.html#af20048b9fc20d9ba4342acf68ee704b0">Ipopt::UserScaling::operator=</a></div><div class="ttdeci">void operator=(const UserScaling &amp;)</div><div class="ttdoc">Default Assignment Operator.</div></div>
<div class="ttc" id="anamespaceIpopt_html"><div class="ttname"><a href="namespaceIpopt.html">Ipopt</a></div><div class="ttdoc">This file contains a base class for all exceptions and a set of macros to help with exceptions.</div><div class="ttdef"><b>Definition:</b> <a href="IpInexactAlgBuilder_8hpp_source.html#l00013">IpInexactAlgBuilder.hpp:14</a></div></div>
<div class="ttc" id="aclassIpopt_1_1Matrix_html"><div class="ttname"><a href="classIpopt_1_1Matrix.html">Ipopt::Matrix</a></div><div class="ttdoc">Matrix Base Class.</div><div class="ttdef"><b>Definition:</b> <a href="IpMatrix_8hpp_source.html#l00027">IpMatrix.hpp:28</a></div></div>
<div class="ttc" id="aIpNLP_8hpp_html"><div class="ttname"><a href="IpNLP_8hpp.html">IpNLP.hpp</a></div></div>
<div class="ttc" id="aclassIpopt_1_1UserScaling_html_ae5e755c567dde8242cfed24e3adcec75"><div class="ttname"><a href="classIpopt_1_1UserScaling.html#ae5e755c567dde8242cfed24e3adcec75">Ipopt::UserScaling::UserScaling</a></div><div class="ttdeci">UserScaling(const UserScaling &amp;)</div><div class="ttdoc">Copy Constructor.</div></div>
<div class="ttc" id="aclassIpopt_1_1SmartPtr_html"><div class="ttname"><a href="classIpopt_1_1SmartPtr.html">Ipopt::SmartPtr</a></div><div class="ttdoc">Template class for Smart Pointers.</div><div class="ttdef"><b>Definition:</b> <a href="IpSmartPtr_8hpp_source.html#l00164">IpSmartPtr.hpp:165</a></div></div>
<div class="ttc" id="aclassIpopt_1_1StandardScalingBase_html_a9735330546368626cfdd8f9855ff2b40"><div class="ttname"><a href="classIpopt_1_1StandardScalingBase.html#a9735330546368626cfdd8f9855ff2b40">Ipopt::StandardScalingBase::StandardScalingBase</a></div><div class="ttdeci">StandardScalingBase()</div></div>
<div class="ttc" id="anamespaceIpopt_html_ab75ce5f2ad60aa86e4dff723998e653f"><div class="ttname"><a href="namespaceIpopt.html#ab75ce5f2ad60aa86e4dff723998e653f">Ipopt::Number</a></div><div class="ttdeci">ipnumber Number</div><div class="ttdoc">Type of all numbers.</div><div class="ttdef"><b>Definition:</b> <a href="IpTypes_8hpp_source.html#l00017">IpTypes.hpp:17</a></div></div>
<div class="ttc" id="aclassIpopt_1_1UserScaling_html_acd3ac1550bfb0bc0885ebb28dfadae10"><div class="ttname"><a href="classIpopt_1_1UserScaling.html#acd3ac1550bfb0bc0885ebb28dfadae10">Ipopt::UserScaling::UserScaling</a></div><div class="ttdeci">UserScaling(const SmartPtr&lt; const NLP &gt; &amp;nlp)</div><div class="ttdef"><b>Definition:</b> <a href="IpUserScaling_8hpp_source.html#l00023">IpUserScaling.hpp:23</a></div></div>
<div class="ttc" id="aclassIpopt_1_1Vector_html"><div class="ttname"><a href="classIpopt_1_1Vector.html">Ipopt::Vector</a></div><div class="ttdoc">Vector Base Class.</div><div class="ttdef"><b>Definition:</b> <a href="IpVector_8hpp_source.html#l00047">IpVector.hpp:48</a></div></div>
<div class="ttc" id="aclassIpopt_1_1UserScaling_html_a560694066aa89b8367c221e9d40cff72"><div class="ttname"><a href="classIpopt_1_1UserScaling.html#a560694066aa89b8367c221e9d40cff72">Ipopt::UserScaling::nlp_</a></div><div class="ttdeci">SmartPtr&lt; const NLP &gt; nlp_</div><div class="ttdoc">pointer to the NLP to get scaling parameters</div><div class="ttdef"><b>Definition:</b> <a href="IpUserScaling_8hpp_source.html#l00076">IpUserScaling.hpp:76</a></div></div>
<div class="ttc" id="aclassIpopt_1_1UserScaling_html_ac109793d9baf2fe593019fe4796ee9d7"><div class="ttname"><a href="classIpopt_1_1UserScaling.html#ac109793d9baf2fe593019fe4796ee9d7">Ipopt::UserScaling::~UserScaling</a></div><div class="ttdeci">virtual ~UserScaling()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> <a href="IpUserScaling_8hpp_source.html#l00030">IpUserScaling.hpp:30</a></div></div>
</body>
</html>
